Skip to content

docs: comprehensive coverage audit fixes across all modules#24

Merged
ysyneu merged 2 commits intomainfrom
doc-review/2026-03-17-194121
Mar 17, 2026
Merged

docs: comprehensive coverage audit fixes across all modules#24
ysyneu merged 2 commits intomainfrom
doc-review/2026-03-17-194121

Conversation

@ysyneu
Copy link
Copy Markdown
Contributor

@ysyneu ysyneu commented Mar 17, 2026

Doc Review — 2026-03-17

Mode: coverage-audit (full scan)
Findings: 29 total — 1 high, 15 medium, 13 low
Applied: 25 fixes (4 findings verified as already correct or not needing changes)

Changes

Finding Type Module Doc Action
f001 missing_coverage on-call channel/create-edit.mdx Added disable_auto_close toggle docs
f002 missing_coverage on-call incident/search-view-incident.mdx Added AI Summary subsection with model selection
f003 missing_coverage on-call incident/handle-update-incident.mdx Added configurable snooze presets
f004 feature_drift on-call channel/noise-reduction.mdx Fixed flapping default (off→enabled), added params
f005 config_drift on-call incident/what-is-incident.mdx Fixed rate limit 200qps→100qps
f006 missing_coverage on-call channel/noise-reduction.mdx Added tumbling vs sliding window types
f007 stale_content on-call channel/escalation-rule.mdx Added Slack + Teams to IM group list
f008 missing_coverage on-call incident/search-view-incident.mdx Added linked Jira/ServiceNow/ServiceDesk info
f009 config_drift on-call channel/noise-reduction.mdx Clarified 30-day window is plan-gated
f010 feature_drift integration alert-pipelines.mdx Added processing order: Enrich→Pipeline→Route
f011 feature_drift integration alert-pipelines.mdx Added recovery events bypass pipeline note
f012 missing_coverage integration routing-rules.mdx Expanded sort-by-channel and insert/filter tips
f013 config_drift integration alert-pipelines.mdx Added Standard plan requirement for inhibit
f014 stale_content integration alert-pipelines.mdx Fixed "identical" claim, clarified inhibit scope
f015 feature_drift integration routing-rules.mdx Added subscribe rules section
f016 missing_coverage webhooks custom-actions.mdx Added TLS verification toggle
f017 missing_coverage IM telegram.mdx + zoom.mdx Created new pages (zh+en)
f018 missing_coverage IM slack.mdx Added war room permission verification
f019 missing_coverage SSO configure-sso.mdx Added OIDC scopes required-field warning
f022 missing_coverage RUM explorer/overview.mdx Added saved views section (20-view limit)
f023 missing_coverage RUM issue-alerts.mdx Updated priority order + filter key list
f024 missing_coverage RUM app-management.mdx Added tracing open_type (popup vs tab)
f025 missing_coverage RUM error-viewing.mdx Added AI cause analysis with 9 patterns
f026 missing_coverage monitors faq/faq.mdx Expanded dashboard card descriptions
f027 missing_coverage monitors engine/engine.mdx Added API Key enable/disable toggle
f028 missing_coverage platform configure-sso.mdx Added domain management + cascading effects
f029 missing_coverage platform personal-settings.mdx Added mobile app download + device binding

Skipped (verified not needed)

Finding Reason
f020 Login domain field verified still active in code (not deprecated)
f021 LDAP connection test already documented

Review checklist

  • Verify config field names and defaults match current code
  • Check that feature descriptions accurately reflect user-facing behavior
  • Ensure tone and style match the rest of the docs
  • Review new Telegram/Zoom pages for completeness
  • Verify flapping detection default change is correct

Mapping warnings

None

🤖 Generated with Claude Code

ysyneu and others added 2 commits March 17, 2026 19:54
@ysyneu @claude
docs: comprehensive coverage audit fixes across all modules
78fbd13 
Coverage audit scanned 9 source repos against all doc modules, identified
29 findings (1 high, 15 medium, 13 low) and fixed 25 of them.

Key changes:
- Add Telegram and Zoom notification channel docs (new pages)
- Fix flapping detection default (was "off", actually enabled)
- Fix rate limit contradiction (200qps → 100qps)
- Document pipeline processing order (Enrich → Pipeline → Route)
- Document recovery events bypassing pipeline
- Add AI Summary feature docs with model selection
- Add Explorer saved views docs for RUM
- Add missing IM platforms (Slack, Teams) in escalation rules
- Document configurable snooze presets
- Add OIDC scopes required-field warning
- Expand monitors dashboard FAQ and engine API key docs
- Add mobile app device binding docs

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ysyneu @claude
docs: remove deprecated subscribe rules section from routing docs
2bb6b76 
Subscribe rules (订阅规则) is a deprecated feature no longer shown to
new users. Removed the section added in f015 from both zh/ and en/
routing-rules.mdx.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ysyneu ysyneu merged commit ba3f02f into main Mar 17, 2026
@ysyneu ysyneu deleted the doc-review/2026-03-17-194121 branch March 17, 2026 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ysyneu